Compodoc 的常用命令

最近在学习 nestjs，用到了 Compodoc。发现配置文件里面的可配置项挺多的，记录一下自己用到的配置项

官网：https://compodoc.app/guides/installation.html

首先安装 compodoc。 然后在 package.json 里面写一条 script 启动 compodoc。

新建一个compodoc配置文件，文件名可以随便取，要和package.json 里面的命令路径对的上。

compodoc配置文件要写上一个 $schema .这样写 json 的时候才有语法提示。

{   
    "$schema": "./node_modules/@compodoc/compodoc/src/config/schema.json",
    "port": 8888,
    "theme": "gitbook",
    "language": "zh-CN",
    "open": true,
    "serve": true,
    "watch": true,
    "tsconfig": "./tsconfig.json"
}

port

运行的端口号， 搭配serve使用

serve

创建一个服务器打开编译后的文件

watch

监听文件改动，重新生成文件

open

编译文件后自动访问文档地址

language

设置语言，我设置后没有效果